如何写系统的使用文档

软件的使用文档分为两种常见的写法，一种是俗称“点点点”的帮助手册类使用文档，告知用户每一步需要点击的按钮，用系统的截图及指示去展现；另一种是偏需求文档的形式，告知用户为什么这样操作，怎么操作。下面具体分析两种写法风格的场景选择及写发分析。

此类使用文档多用于业务逻辑简单的系统，大多数的逻辑在页面上可以展示，用户只需要知道系统的使用流程，在哪些模块实现哪些操作即可。用系统截图+箭头/符号的视觉指引来引导点击区域，附带着一些注意事项类的文字，基本可说明使用情况。具体的内容划分如下：

此类使用文档多用于复杂逻辑的系统，很多隐藏的逻辑在页面上无法看出，很多后台设定的流程或逻辑，需要文档中说明；另一种情况是针对于强业务系统，尤其B端的系统居多，业务逻辑很多，需要以此文档给使用者讲清楚业务逻辑后，再加入“点点点”的操作。具体内容划分如下：

使用文档一般按照用户角色区分，每一种用户都有一份使用文档，常见的系统有前端，后台两个大块，即分为后台管理员使用说明书和用户使用说明书，如系统较大，比如OA系统，后台可以继续拆分，如财务人员使用说明书，crm管理员使用说明书，业务管理员使用说明书等等。

正规的文档的格式，可以按以下的结构去写，主要包括：文档控制部分、前言、使用说明和注意事项。详细说明分别如下：

文档控制部分

这部分主要说明文档的更新迭代及编辑情况，便于文档的管理，也给阅读的人清晰的版本说明。此部分主要包含以下几点：标题、版本号、修改记录编制日期，编制人，版本号，编制内容（这部分多用一个表格去展现。）

前言

前言部分主要给使用者一个概述性的引导说明，概述说明系统的逻辑，适用的用户群，以及主要的业务场景。另一方面指出本份文档针对的用户是哪一部分，给出一个简短的说明。前言部分概括为以下两点：系统概述：逻辑说明、用户群、业务场景。文档目标人群：本实用文档主要针对于xxx用户，便于用户了解系统的使用方法，系统逻辑...便于用户尽快上手尽快使用本系统。

使用说明

此部分为说明书的核心部分，通常是按业务逻辑，将系统分为不同的业务模块分别说明，如注册登录，浏览商品，下订单，结算，红包金额提现…各模块可以分别作为一个二级标题，分段去说明。

注意事项

注意事项部分主要指出一些业务的边界，法律上的声明，文档的版权保护等等内容。文档版权归属一般放置在页眉，业务边界等内容，如果有必要的话，可单独放成一个模块，也可以在业务说明后，写注意事项的部分。

xxxx系统使用文档编制：xxx生成日期：2018-09-08版本：v2.0

文档控制

前言系统介绍本系统是xxxx

目标人群通过阅读该操作手册，可以帮助xxxx尽快熟悉在xxxx系统的相关操作。

使用说明功能一功能二...

注意事项免责声明...版权声明...业务边界...